Jira Integration

A Jira integration with Cloudhouse Guardian (Guardian) allows you to automatically create Jira tickets after certain events take place. For example, in the event of a failed scan, you can configure this as an Action that automatically creates a ticket on a Jira board when a scan fails. This is useful if your team uses Jira to track issues that need to be addressed or triaged. This topic describes the steps you need to complete to setup a Jira integration with Guardian.

Note: This topic focuses on setting up the Jira integration. If you've already set up the integration and want to configure Jira actions, see Action: Create a Jira Ticket.

Dependencies

To add a Jira integration, you need the following:

  • A Jira account – This could be an existing user account, but we recommend setting up a brand new user account named 'Guardian' for easier identification.

  • An API token – For more information, see Manage API Tokens for your Atlassian Account.

Add a Jira Integration

Integrating Jira withGuardianestablishes a seamless connection to automatically create Jira tickets after certain events take place.

To add a Jira integration to Guardian, complete the following:

  1. In the Guardian web application, navigate to the Integrations tab (Control > Integrations) and click Add Integration. The Add Integration page is displayed.

  2. Select Jira from the list of available integrations. Here, you are required to complete the following options:

    Option

    Description

    Account URL field

    The unique URL of your company’s Jira instance. For example,https://yourcompany.atlassian.net.
    Authentication radio buttons

    The authentication method to connect to your company's Jira instance. Select from the following options:

    • 'Basic Auth' – Displays theUsername and API Token fields, as described below.

    • 'Personal Access Token' – Displays thePersonal Access Token field, as described below.

    Username field

    The username of the Jira account to connect to your instance.

    Note: This field is only displayed when 'Basic Auth' is selected as the authentication method.

    API Token field

    The Jira API token required to authenticate Guardian's access to the Jira account.

    If you are editing an existing integration and the token hasn't changed, you can leave this field blank.

    Note: This field is only displayed when 'Basic Auth' is selected as the authentication method.

    Personal Access Token field

    The Personal Access Token (PAT) required to authenticate Guardian's access to the Jira account. For more information on how to source this, see Using Personal Access Tokens.

    If you are editing an existing integration and the token hasn't changed, you can leave this field blank.

    This field is only displayed when 'Personal Access Token' is selected as the authentication method.

    Tip: This feature was introduced in V4.3.47.2 of Guardian. For more information, see August 2024 Monthly Release.

    Bypass Certificate Validation (not recommended) checkbox

    Option to ignore the SSL certificate check on your Jira instance. If selected, Guardian will not consider the SSL certificate that encrypts web traffic to keep user data secure. This is not recommended unless required for troubleshooting.

    Legacy Server Connect (not recommended) checkbox

    Option to allow legacy insecure renegotiation when connecting to your Jira instance. If selected Guardian will allow the negotiation of older insecure SSL options. This is not recommended unless required for troubleshooting.

    Enable Verbose Logging (not recommended) checkbox

    Option to enable verbose integration logging. If selected, Guardian will collect extra information for troubleshooting purposes. This is not recommended unless required for troubleshooting.

  3. Once you have set the correct values for each of the options displayed, click Done to create the Jira integration.

If successful, a confirmation message is displayed and the Jira integration is added to the Integrations tab of your Guardian instance. If unsuccessful, an error message is displayed. Use the information displayed in the error message(s) to troubleshoot the values in your Jira Integration options.

Troubleshooting

If you are experiencing issues with your integration, try the following:

  • Verify that the values supplied for the integration are correct.

  • You may need to make some security level changes on your Jira instance if you encounter issues adding a Jira integration. Please contact your Guardian Representative if required.

  • To confirm the status of the integration sync, check the integration sync event in the Events tab (Control > Events) of your Guardian instance. For more information, see Events.